home *** CD-ROM | disk | FTP | other *** search
/ Popular Request / By Popular Request (Arsenal Computer)(SysOptics Distribution System).ISO / amiga3 / plfuti20.lha / PLFUtil / docs / PLFUtil.doc < prev   
Text File  |  1994-01-09  |  18KB  |  494 lines
  1.  
  2.       
  3.                                  P L F U t i l
  4.  
  5.                                by Patrick Langer
  6.  
  7.                                   Version 2.0
  8.  
  9.                                     20.11.93
  10.  
  11.  
  12.      1.0 INTRODUCTION
  13.  
  14.      Welcome  to  PLFUtil.  This is the first release of my replacement for
  15.      Tim Astons fileutil.rexx written for TransAmiga V1.1.  As the original
  16.      program  was just a basic arexx program, it hadn't that much features.
  17.      I  needed  a  program  which  reads my filenotes and put them into the
  18.      'Files.BBS'  without  cutting  them after 40 characters, so I modified
  19.      this  routine.   Then  I  started  to use download counters (made with
  20.      DCount  1.30  by  T.  Boerkel), which were written into Files.BBS.  On
  21.      the  other  hand,  the newer releases of my File Request handler (FFRS
  22.      V2.01b  by  F.   Wauquier)  had the option to write a download counter
  23.      into  the  filenotes.   This  was the problem I tried to solve with my
  24.      first  (internal)  versions of PLFUtil.  As I programmed it, new ideas
  25.      came to my mind and were added.  And this is it and I think it's quite
  26.      good :-)
  27.  
  28.  
  29.  
  30.      2.0 LEGAL STUFF
  31.  
  32.  
  33.      2.1 This program (PLFUtil) is copyrighted (c) 1993 by Patrick Langer.
  34.  
  35.  
  36.      2.2 Permission is hereby granted  to  distribute  this  program  and
  37.      associated  documentation provided all of the following conditions are
  38.      met :
  39.  
  40.           a. No charge is made except for media costs, a small copying  fee
  41.              (which can be any amount up to the cost of the media used) and
  42.              postage charges.
  43.           b. The original archive should remain intact.  This means that at
  44.              least the following files must be included in unaltered form:
  45.                      PLFUtil.rexx
  46.                      PLFUtil.doc
  47.              You may archive these files using a popular archiving  package
  48.              (eg. LhA).
  49.           c. If  you  are  asked  in writing by myself to stop distributing
  50.              this program, you must do so immediately.
  51.           d. No part of this software package may be used in part or  whole
  52.              for  commercial purposes without prior written permission from
  53.              myself.
  54.  
  55.  
  56.      2.3.  You may modify the PLFUtil.rexx file for your own use.  Modified
  57.      copies  must  not  be  distributed (but you can send me a note on what
  58.      you've modified).
  59.  
  60.  
  61.      2.4.   This  software  is  provided  without  warranty.   I  take   no
  62.      responsibility  for  any  consequences  of  the  use or misuse of this
  63.      software.
  64.  
  65.  
  66.      2.5.  This program  may  be  used  for  free  in  any  non  commercial
  67.      environment.
  68.  
  69.  
  70.  
  71.      3.0 FEATURES
  72.  
  73.          PLFUtil has the following features :
  74.  
  75.      * it can read filenotes and put them into a Files.BBS
  76.      * it  can  read  a  Files.BBS  and  put  the  descriptions  into  the
  77.        corresponding filenotes
  78.      * it can handle descriptions or filenotes longer than 40 characters
  79.      * it can sort your Files.BBS alphabetically
  80.      * A kind of bulk upload feature:  if a file has no filenote, PLFUtil
  81.        will a) ask you to give a description or b) put in a given default
  82.        description
  83.      * PLFUtil can read your file.cfg and perform actions on ALL fileareas
  84.        or just in a given path
  85.      * Now PLFUtil can create a filelisting with many options
  86.  
  87.      Usage:
  88.  
  89.      rx PLFUtil [command] [options]
  90.  
  91.      Command can be:
  92.  
  93.      N       Create filenotes from Files.BBS
  94.      B       Create Files.BBS from filenotes
  95.      C       Create Filelisting from Files.BBS
  96.  
  97.      Options for all commands:
  98.  
  99.      CONFIGS <path>     Path for file.cfg [Default: bbs:configs/]
  100.  
  101.      Options for B/N only:
  102.  
  103.      PATH <path>        Scan only given dir [Default: Scan all]
  104.      DCOUNT             Create Download Counter [Default: No Dload Counters]
  105.      LOG <path>         Path to transamiga.log (needs DCOUNT) [Default: bbs:system/transamiga.log]
  106.  
  107.      Options for B only:
  108.  
  109.      NOSORT             Do not sort Files.BBS [Default: Sort]
  110.      QUIET              Do not ask for file description [Default: Ask for it]
  111.  
  112.      Options for C only:
  113.  
  114.      NAME <name>        Path and name for filelisting [Default: ram:Fileliste]
  115.      FROM <level>       Access level to start with [Default: 0]
  116.      TO <level>         Access level to end with [Default: 255]
  117.      DAYS <days>        Age of files to appear [Default: list all files]
  118.      NEW <days>         Age of files to be marked NEW (*) [Default: 14]
  119.      HEADER <name>      Name for textfile to be included as header [Default: no header]
  120.  
  121.  
  122.  
  123.      4.1 Description of commands
  124.  
  125.  
  126.      4.1.1 The 'N' option:
  127.  
  128.      This  command  will  create  filenotes  using  the descriptions in the
  129.      Files.BBS. There are several options to use described below.
  130.  
  131.  
  132.      4.1.2 The 'B' option:
  133.  
  134.      With  this command you can create a Files.BBS from the filenotes added
  135.      to  the  files  in your file areas (if you have them.  If not, you can
  136.      first create them using the 'N' option).
  137.  
  138.  
  139.      4.1.3 The 'C' option:
  140.  
  141.      This  command will create those fancy filelistings often used in BBS'.
  142.      The options described later will enable you to create kinda 'Allfiles'
  143.      listings and 'Newfiles' listings, using given ranges of access levels
  144.      and  marking new files (defined by user) and so on.  When no files are
  145.      listed  (especially  when  using the DAYS option) no file list will be
  146.      created.   This is useful when posting 'Newfiles' messages in a BBS or
  147.      so  to  avoid  'empty'  file  lists.   See  below  for  more  detailed
  148.      information.
  149.  
  150.  
  151.      4.2 Description of options
  152.  
  153.      I will now describe the numerous options of PLFUtil:
  154.  
  155.  
  156.      4.2.1 Option for all commands:
  157.  
  158.      CONFIG <path>
  159.  
  160.      Here you can define your path to the file.cfg.
  161.      Default: bbs:configs/
  162.  
  163.  
  164.      4.2.2 Options for B/N only:
  165.  
  166.      PATH <path>
  167.  
  168.      When  you  want  to  use  the B or N command just on one area, you can
  169.      define a path here which will be used then.
  170.  
  171.  
  172.      DCOUNT
  173.  
  174.      Will  create  Download  counter  like  DCount  (by T.  Boerkel) in the
  175.      format  '[?]'.   This  option  will  add [0] where no Download counter
  176.      exists.   It  also  scans the transamiga logfile for downloads, counts
  177.      them  and  add  them  to  the download counter.  
  178.      Default:  No Download counters are created
  179.  
  180.      LOG <path>
  181.  
  182.      This  defines  the path to the TransAmiga logfile.  The path is needed
  183.      by the DCOUNT option.
  184.      Default: bbs:system/transamiga.log
  185.  
  186.  
  187.      4.2.3 Options for B only:
  188.  
  189.      NOSORT
  190.  
  191.      This will suppress the sorting of Files.BBS
  192.      Default: Sort
  193.  
  194.      QUIET
  195.  
  196.      This  will  suppress the question for a file description where none is
  197.      found  in  the  filenotes.   If  this  option  is  chosen,  a  default
  198.      description will be used.
  199.  
  200.  
  201.      4.2.4 Options for C only:
  202.  
  203.      NAME <name>
  204.  
  205.      The path and name of the file list you want to create
  206.      [Default: ram:Fileliste]
  207.  
  208.      FROM <level>
  209.  
  210.      Access level with which the file list will start
  211.      [Default: 0]
  212.  
  213.      TO <level>
  214.  
  215.      Access level with which the file list will end
  216.      [Default: 255]
  217.  
  218.      DAYS <days>
  219.  
  220.      Age of files in number of days which will appear in the file list
  221.      [Default: list all files]
  222.  
  223.      NEW <days>
  224.  
  225.      Age  of  files  in number of days to be marked as NEW with an asterisk
  226.      (*) after the date
  227.      [Default: 14]
  228.  
  229.      HEADER <name>
  230.  
  231.      Name for textfile to be included as a header of the file list
  232.      [Default: no header]
  233.  
  234.  
  235.      <path>  must be a valid AmigaDOS path and must end with an ':' or '/',
  236.      e.g.  'FILE:GAMES/'
  237.  
  238.  
  239.  
  240.      ATTENTION!
  241.  
  242.      PLFUtil  will  not  take  care  of your old Files.BBS!  It will simply
  243.      delete  it  and  create  the  new  one.  If you use '\' lines for area
  244.      descriptions  or  the  like, they will be deleted!  Remember, you have
  245.      been warned.
  246.  
  247.      If  you  want to test PLFUtil, I suggest that you choose one file area
  248.      directory,  make a backup of your original Files.BBS and start testing
  249.      by  creating  a  PLFUtil-style  Files.BBS  with 'rx PLFUtil B <path>'.
  250.      With  this,  you can play around (even better, make this with the long
  251.      description  option,  also  make  a copy of this Files.BBS and you can
  252.      play around as you like :-) )
  253.  
  254.  
  255.  
  256.      5.0 EXAMPLES
  257.  
  258.      In the following I will give some examples for the use of PLFUtil.
  259.  
  260.  
  261.      5.1 Using the 'B' command
  262.  
  263.      You have this file area:
  264.  
  265.      ----------------------------------------------------------------------
  266.  
  267.      Directory "file:modules" on Freitag 08-Okt-93 
  268.      EaglePlayer101.lha        307274 ----rwed 12-Sep-93  12:41:09
  269.      : [0] absolut guter Mod-Player
  270.      exoticripper.DMS          187597 ----rwed 13-Mai-93  18:53:53
  271.      : [0] guter Module-Ripper
  272.      JukeBox11.lha              14329 ----rwed 12-Sep-93  16:02:04
  273.      : [0]  --- No description available ---
  274.      STP140.lha                 90298 ----rwed 12-Sep-93  15:13:42
  275.      : [0] Mod-Player mit schoener Oberflaeche und guten Funktionen!
  276.      ExoticRipper20.lha         35460 ----rwed 12-Sep-93  23:14:24
  277.      : [0] Sound Ripper, gut!
  278.      Jukebox.lha               124685 ----rwed 28-Feb-93  20:44:58
  279.      : [0] Abspielprogramm fuer Audio-CDs per CD-ROM
  280.      ProTracker301.lha         132065 ----rwed 12-Sep-93  22:08:13
  281.      : [0] DER Tracker!
  282.      Files.BBS                    989 ----rwed Gestern    22:01:11
  283.      upd1_30.lha                22316 ----rwed 16-Mai-93  00:04:26
  284.      : [0] winziger Sound-Player, gut geeignet fuer Scripts u.ae.
  285.      DSound130.lha              27796 ----rwed 21-Sep-93  00:59:24
  286.      : [0] Spielt Samples
  287.      DMODP170.ADS                2209 ----rwed Gestern    04:06:02
  288.      : ADSWORK2: DModP V1.70 - Long Desc.
  289.      DMODP170.LHA               76483 ----rwed Gestern    04:06:07
  290.      : ADSWORK2: Module player for PT/MMD0-2/DSS0 modules.
  291.      12 files - 2036 blocks used
  292.  
  293.  
  294.      By using 'rx plfutil B file:modules/' you will get this Files.BBS:
  295.  
  296.      ----------------------------------------------------------------------
  297.  
  298.      DMODP170.ADS               2209 931007 ADSWORK2: DModP V1.70 - Long Desc.
  299.      DMODP170.LHA              76483 931007 ADSWORK2: Module player for
  300.      \                                      PT/MMD0-2/DSS0 modules.
  301.      DSound130.lha             27796 930921 [0] Spielt Samples
  302.      EaglePlayer101.lha       307274 930912 [0] absolut guter Mod-Player
  303.      exoticripper.DMS         187597 930513 [0] guter Module-Ripper
  304.      ExoticRipper20.lha        35460 930912 [0] Sound Ripper, gut!
  305.      Jukebox.lha              124685 930228 [0] Abspielprogramm fuer Audio-CDs per
  306.      \                                      CD-ROM
  307.      JukeBox11.lha             14329 930912 [0]  --- No description available ---
  308.      ProTracker301.lha        132065 930912 [0] DER Tracker!
  309.      STP140.lha                90298 930912 [0] Mod-Player mit schoener Oberflaeche
  310.      \                                      und guten Funktionen!
  311.      upd1_30.lha               22316 930516 [0] winziger Sound-Player, gut geeignet
  312.      \                                      fuer Scripts u.ae.
  313.  
  314.      This Files.BBS is sorted, using the long description feature.  Look at
  315.      it and you will see how PLFUtil works.
  316.  
  317.  
  318.      5.3 Using the 'N' command
  319.  
  320.      Using  'rx  plfutil  N file:modules/' will act vice versa to the above
  321.      example.
  322.  
  323.  
  324.      5.4 Using th 'C' command
  325.  
  326.      Using 'rx plfutil C' will create the file list below (for my system):
  327.  
  328.      ----------------------------------------------------------------------
  329.  
  330. Listing of files for Access level 0 to 255:
  331.  
  332. File Area 1 : AMIGA: Boxinternes                            Access Level: 0
  333.  
  334.   Name                 Size    Date      Description
  335.  +--------------------+-------+---------+-----------------------------------------+
  336.  |02463103.LHA        |  28353|26-09-93*|[3]  --- No description available ---    |
  337.  |02463103.LST        | 132620|06-10-93*|Fileliste der Jugglers Inn (ungepackt)   |
  338.  |NEWFILES.LHA        |   7748|26-09-93*|[2]  --- No description available ---    |
  339.  |NEWFILES.LST        |  19529|06-10-93*|Neue Files der letzten 14 Tage           |
  340.  |                    |       |         |(ungepackt)                              |
  341.  +--------------------+-------+---------+-----------------------------------------+
  342.  | 4 Files in this area. Total size: 188250 bytes                                 |
  343.  +--------------------------------------------------------------------------------+
  344.  
  345. File Area 2 : AMIGA: File-Listen anderer BBS                Access Level: 0
  346.  
  347.   Name                 Size    Date      Description
  348.  +--------------------+-------+---------+-----------------------------------------+
  349.  |02461416.lha        |  59408|11-09-93 |[2] Fileliste der Amiga Universe         |
  350.  |                    |       |         |(07195-61970)                            |
  351.  |02473501.lha        |  38537|11-09-93 |[0] Fileliste von Hardy's Error Node     |
  352.  |                    |       |         |(089-8206827)                            |
  353.  |24070106.lzh        |  87870|11-09-93 |[1] Fileliste der Intuition Base         |
  354.  |                    |       |         |(07152-45768)                            |
  355.  |aoplist.lha         | 217462|07-09-93 |[3] Fileliste der Amiga on Phone         |
  356.  |                    |       |         |(0721-859432)                            |
  357.  +--------------------+-------+---------+-----------------------------------------+
  358.  | 4 Files in this area. Total size: 403277 bytes                                 |
  359.  +--------------------------------------------------------------------------------+
  360. [...]
  361. End of listing.
  362.  
  363. ** Number of Files listed:             1369
  364. ** Total size of Files listed:    192734802
  365.  
  366. Filelist created with PLFUtil V2.0 by Patrick Langer on 08 Oct 1993 at 00:51:05
  367.  
  368.      ----------------------------------------------------------------------
  369.  
  370.  
  371.  
  372.      6.0 ABOUT THE DESCRIPTION FORMATm
  373.  
  374.  
  375.      6.1 The Idea
  376.  
  377.      In  TransAmiga  I  always  disliked  the  limit  of descriptions to 40
  378.      characters.  When for examples receiving files from ADS, I alwys added
  379.      the  descriptions  send  as filenotes to the archives.  In the TA file
  380.      listings,  due  to  the  limit  of  40  characters, some of these file
  381.      descriptions  were crippled in a way that you could hardly recognize a
  382.      description  for that file.  Also, the amount of information you could
  383.      enter was limited.  As many programs used already the filenotes (which
  384.      can  actually  be  twice as long as the TA description) to create file
  385.      listings  or  the  Files.BBS,  I tried to find a way to use almost the
  386.      complete  filenote as description for TA.  The simpliest way to manage
  387.      this  was to take the part of the filenote, that couldn't be displayed
  388.      by TA and put it into the next line as a '\' comment.  That's all!
  389.  
  390.  
  391.      6.2 Known Problems
  392.  
  393.      Well,  first  of  all,  people already using the '\' comment lines for
  394.      other  purposes  will  not be happy with PLFUtil because (as mentioned
  395.      above) it will simply ignore them and delete them.
  396.  
  397.      The  next  problem  appears when using FileScroller by Eric Sauvageau.
  398.      It  sees my additional description lines as comment lines and displays
  399.      them  in  an  other  color as the rest.  Looks a bit funny but does no
  400.      harm :-)
  401.  
  402.      There  may be problems with file list generators which will ignore the
  403.      '\'  comment  lines  (or  simply  strip  them  from the Files.BBS like
  404.      Rifle2.10  by  M.Kuhne).  Problems may also occure when these programs
  405.      try to sort the Files.BBS alphabetically. At the present, I use EFLG
  406.      by Robert Hofmann, which is actually no real TA program but uses the
  407.      filenotes also in full length (also spread over several lines)
  408.  
  409.  
  410.  
  411.      7.0 OTHER THINGS
  412.  
  413.  
  414.      7.1 The Future
  415.  
  416.      Well, I have some ideas in mind which still want to be realised:
  417.  
  418.      * no destroying of '\' comments previously present
  419.      * optimizing routines
  420.      * Rewrite in E!
  421.      * some other small things
  422.  
  423.  
  424.      7.2 Bug Reports, Suggestions, Loads of money and bags of gold :-)
  425.  
  426.      via E-mail:
  427.  
  428.      planger@juglers.in-ulm.de
  429.  
  430.      via FidoNet:
  431.  
  432.      Patrick Langer
  433.      2:246/3103
  434.  
  435.      via AmigaNet:
  436.  
  437.      Patrick Langer
  438.      39:173/30
  439.  
  440.      or, via snail-mail:
  441.  
  442.      Patrick Langer
  443.      Dr.-Rau-Weg 8
  444.      73312 Geislingen
  445.  
  446.      GERMANY
  447.  
  448.      or, you can try to reach me (or my answer machine) by calling:
  449.  
  450.      49-7331-44435
  451.  
  452.      If you find this tool useful, please send me a short note!
  453.  
  454.  
  455.      7.3 Acknowledgements
  456.  
  457.      Thanks go to:
  458.  
  459.      - Tim Aston for his wunderful BBS program TransAmiga (still waiting
  460.        for the next version!)
  461.      - Sami Radwan for having such a good TA support BBS here in Germany
  462.      - T. Boerkel for his DCount (quite fast!)
  463.      - E. Sauvageau for his beautiful and amazing FileScroller
  464.      - of course, Commodore for this great machine
  465.      - and to all other, who deserve to be mentioned in this part of a doc
  466.        but never were
  467.  
  468.  
  469.      7.4 History
  470.  
  471.      1.0 first public release (27.09.93)
  472.  
  473.      1.1 fixed some nasty bugs (29.09.93)
  474.  
  475.      1.2 changed date conversion routine (30.09.93)
  476.  
  477.      1.3 started adding the filelisting option (01.10.93)
  478.  
  479.      1.4 most  features  implemented  now.  Removed the config part in the
  480.          programm text and put it into the command line (06.10.93)
  481.  
  482.      1.5 finished  implementing  the  filelisting  option,  also made some
  483.          optical improvements and optimized some code (08.10.93)
  484.  
  485.      1.6 now uses FileSort (included in the archive) by Rod Schnell to sort
  486.          the Files.BBS (15.10.93)
  487.  
  488.      1.7 some bugs fixed (20.10.93)
  489.  
  490.      1.9 added the Download counter feature (14.11.93)
  491.  
  492.      2.0 second public release (20.11.93)
  493.  
  494.